Foxit PDF RDK
FoxitRDKNative.EditCommentsTask Class Reference

EditCommentsTask class is used to handle various events related to edit comments, such as import or export comments.. More...

Inheritance diagram for FoxitRDKNative.EditCommentsTask:
FoxitRDKNative.Task

Public Member Functions

 constructor (doc, editType, filePath, cb)
 Constructor for the EditCommentsTask class. More...
 
- Public Member Functions inherited from FoxitRDKNative.Task
 canCancel ()
 Checks if the task can be cancelled. More...
 
 cancel ()
 Cancels the task. Attempts to cancel the task if it is in a cancellable state.
 
 constructor ()
 Constructor for the Task class. Initializes a new instance of the Task.
 
 errorCode ()
 Gets the error code of the task. More...
 
 exeSuccess ()
 Checks if the task was executed successfully. More...
 
 extErrorCode ()
 Gets the extended error code of the task. More...
 
 finish ()
 Marks the task as finished. Completes the task and performs any necessary cleanup.
 
 getPriority ()
 Gets the current priority of the task. More...
 
 getStatus ()
 Gets the current status of the task. More...
 
 isCanceled ()
 Checks if the task has been cancelled. More...
 
 isModify ()
 Checks if the task has been modified. More...
 
 notify (result)
 Notifies about the result of the js funcion. More...
 
 prepare ()
 Prepares the task for execution. Performs any necessary setup before the task can be run.
 
 setErrorCode (error)
 Sets the error code for the task. More...
 
 setPriority (priority)
 Sets the priority of the task. More...
 
 setStatus (status)
 Sets the status of the task. More...
 

Detailed Description

EditCommentsTask class is used to handle various events related to edit comments, such as import or export comments..

Member Function Documentation

◆ constructor()

FoxitRDKNative.EditCommentsTask.constructor ( doc  ,
editType  ,
filePath  ,
cb   
)

Constructor for the EditCommentsTask class.

Parameters
{PDFDoc}doc - The pdfdoc object to be operated on.
{number}editType - The type of edit, defined by the EditCommentsType.
{string}filePath - The file path required for import or export operations.
{EditCommentsTaskCallBack}cb - The callback to be invoked with the result of the task.